Skip to content

(3) core array, function, tuple, sys: Add Scaladoc for undocumented entities - #26669

Draft
bvenners wants to merge 1 commit into
scala:mainfrom
artimahub:scaladoc-missing-docs-core-array-function-tuple-sys
Draft

(3) core array, function, tuple, sys: Add Scaladoc for undocumented entities#26669
bvenners wants to merge 1 commit into
scala:mainfrom
artimahub:scaladoc-missing-docs-core-array-function-tuple-sys

Conversation

@bvenners

Copy link
Copy Markdown
Contributor

This PR fills in a main doc comment plus @PARAM, @tparam, and @return tags for core array, function, tuple, and sys classes that are completely missing any Scaladoc documentation. I'm submitting it as a draft PR so that I can get the CI to run on it, to see if it breaks anything, and to start getting feedback. We automated the generation of these changes and have not reviewed all of them yet. We will review them all before making the PR non-draft. Please let me know whether you think this is going in the right direction in general, and anything specific that you notice that could be improved.

@bvenners bvenners changed the title Add Scaladoc for undocumented core array, function, tuple, and sys APIs (3) core array, function, tuple, sys: Add Scaladoc for undocumented entities Jul 30, 2026

@cheeseng cheeseng left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added manual review.

@annotation.unspecialized def tupled: ((T1, T2, T3, T4, T5, T6, T7)) => R = {
case ((x1, x2, x3, x4, x5, x6, x7)) => apply(x1, x2, x3, x4, x5, x6, x7)
}
/** TODO FILL IN */

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how this is missed, but I think this needs to be filled in.


import scala.language.`2.13`

/** TODO FILL IN

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how this is missed, but I think these needs to be filled in.


import scala.language.`2.13`

/** A base class for zero-parameter function implementations, allowing a function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we include the type parameter R also?


import scala.language.`2.13`

/** A base class for one-parameter function implementations, allowing a function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we include the type parameter T1 and R also?


import scala.language.`2.13`

/** A base class for two-parameter function implementations, allowing a function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we include type parameter T1, T2 and R?

* exception once every line has been yielded if the exit code is non-zero
*/
def lazyLines(log: ProcessLogger, capacity: Integer): LazyList[String] = lazyLines(withInput = false, nonZeroException = true, Some(log), capacity)
/** Returns the standard output of the process represented by this builder as a `LazyList`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@PARAM for capacity and @@return is missing.

* no exception.
*/
def lazyLines_!(capacity: Integer) : LazyList[String] = lazyLines(withInput = false, nonZeroException = false, None, capacity)
/** Returns the standard output of the process represented by this builder as a `LazyList`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@PARAM for log and capacity is missing, also no @@return .


object Function1 {

/** Provides the [[UnliftOps.unlift]] method on functions that return an [[scala.Option]].

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shall we need the @@PARAM for the f?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants